Node / meshtastic / Meshtastic-Android / files / feature / docs / src / commonMain / kotlin / org / meshtastic / feature / docs / model / DocModels.kt

Displaying Raw • Download

T8b949e/*

* Copyright (c) 2026 Meshtastic LLC

*

* This program is free software: you can redistribute it and/or modify

* it under the terms of the GNU General Public License as published by

* the Free Software Foundation, either version 3 of the License, or

* (at your option) any later version.

*

* This program is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

* GNU General Public License for more details.

*

* You should have received a copy of the GNU General Public License

* along with this program. If not, see <https://www.gnu.org/licenses/>.

*/

Tff7b72package T7ee787org.meshtastic.feature.docs.model

Tff7b72import T7ee787kotlinx.serialization.Serializable

Tff7b72import T7ee787org.jetbrains.compose.resources.getString

Tff7b72import T7ee787org.meshtastic.core.resources.Res

Tff7b72import T7ee787org.meshtastic.core.resources.doc_section_developer

Tff7b72import T7ee787org.meshtastic.core.resources.doc_section_user

T8b949e/** Top-level documentation section. */

Tf0883e@Serializable

Tff7b72sealed Tff7b72interface T56d364DocSection Tb4b4b4{

Tf0883e@Serializable Tff7b72data Tff7b72object T56d364UserGuide Tb4b4b4: Te6edf3DocSection

Tf0883e@Serializable Tff7b72data Tff7b72object T56d364DeveloperGuide Tb4b4b4: Te6edf3DocSection

Tff7b72companion Tff7b72object Tb4b4b4{

Tff7b72fun Td2a8fffromStringTb4b4b4(Te6edf3valueTb4b4b4: Tffa657StringTb4b4b4)Tb4b4b4: Te6edf3DocSection Tff7b72= Tff7b72when Tb4b4b4(Te6edf3valueTb4b4b4.Te6edf3lowercaseTb4b4b4(Tb4b4b4)Tb4b4b4) Tb4b4b4{

Ta5d6ff"Ta5d6ffuserTa5d6ff" Tff7b72-Tff7b72> Te6edf3UserGuide

Ta5d6ff"Ta5d6ffdeveloperTa5d6ff" Tff7b72-Tff7b72> Te6edf3DeveloperGuide

Tff7b72else Tff7b72-Tff7b72> Te6edf3UserGuide

Tb4b4b4}

Tff7b72fun Td2a8fftoSlugTb4b4b4(Te6edf3sectionTb4b4b4: Te6edf3DocSectionTb4b4b4)Tb4b4b4: Tffa657String Tff7b72= Tff7b72when Tb4b4b4(Te6edf3sectionTb4b4b4) Tb4b4b4{

Te6edf3UserGuide Tff7b72-Tff7b72> Ta5d6ff"Ta5d6ffuserTa5d6ff"

Te6edf3DeveloperGuide Tff7b72-Tff7b72> Ta5d6ff"Ta5d6ffdeveloperTa5d6ff"

Tb4b4b4}

Tff7b72suspend Tff7b72fun Td2a8ffdisplayNameTb4b4b4(Te6edf3sectionTb4b4b4: Te6edf3DocSectionTb4b4b4)Tb4b4b4: Tffa657String Tff7b72= Tff7b72when Tb4b4b4(Te6edf3sectionTb4b4b4) Tb4b4b4{

Te6edf3UserGuide Tff7b72-Tff7b72> Te6edf3getStringTb4b4b4(Te6edf3ResTb4b4b4.Te6edf3stringTb4b4b4.Te6edf3doc_section_userTb4b4b4)

Te6edf3DeveloperGuide Tff7b72-Tff7b72> Te6edf3getStringTb4b4b4(Te6edf3ResTb4b4b4.Te6edf3stringTb4b4b4.Te6edf3doc_section_developerTb4b4b4)

Tb4b4b4}

Tb4b4b4}

Tb4b4b4}

T8b949e/** A single documentation page. */

Tf0883e@Serializable

Tff7b72data Tff7b72class T56d364DocPageTb4b4b4(

Tff7b72val Te6edf3idTb4b4b4: Tffa657StringTb4b4b4,

Tff7b72val Te6edf3titleTb4b4b4: Tffa657StringTb4b4b4,

Tff7b72val Te6edf3sectionTb4b4b4: Te6edf3DocSectionTb4b4b4,

Tff7b72val Te6edf3navOrderTb4b4b4: Tffa657IntTb4b4b4,

Tff7b72val Te6edf3resourcePathTb4b4b4: Tffa657StringTb4b4b4,

Tff7b72val Te6edf3keywordsTb4b4b4: Te6edf3ListTff7b72<Tffa657StringTff7b72>Tb4b4b4,

Tff7b72val Te6edf3aliasesTb4b4b4: Te6edf3ListTff7b72<Tffa657StringTff7b72> Tff7b72= Te6edf3emptyListTb4b4b4(Tb4b4b4)Tb4b4b4,

Tff7b72val Te6edf3charCountTb4b4b4: Tffa657IntTb4b4b4,

T8b949e/** Icon identifier for TOC display (maps to MeshtasticIcons). */

Tff7b72val Te6edf3iconIdTb4b4b4: Tffa657String? Tff7b72= Tff7b72nullTb4b4b4,

Tb4b4b4)

T8b949e/** Content wrapper that decouples metadata from rendered content. */

Tff7b72data Tff7b72class T56d364DocPageContentTb4b4b4(

Tff7b72val Te6edf3pageTb4b4b4: Te6edf3DocPageTb4b4b4,

Tff7b72val Te6edf3htmlTb4b4b4: Tffa657String? Tff7b72= Tff7b72nullTb4b4b4,

Tff7b72val Te6edf3markdownTb4b4b4: Tffa657String? Tff7b72= Tff7b72nullTb4b4b4,

Tff7b72val Te6edf3cssPathTb4b4b4: Tffa657String? Tff7b72= Tff7b72nullTb4b4b4,

Tb4b4b4)

T8b949e/** Runtime aggregate of the full documentation corpus. */

Tff7b72data Tff7b72class T56d364DocBundleTb4b4b4(

Tff7b72val Te6edf3pagesTb4b4b4: Te6edf3ListTff7b72<Te6edf3DocPageTff7b72>Tb4b4b4,

Tff7b72val Te6edf3pageIndexTb4b4b4: Te6edf3MapTff7b72<Tffa657StringTb4b4b4, Te6edf3DocPageTff7b72>Tb4b4b4,

Tff7b72val Te6edf3bundleVersionTb4b4b4: Tffa657StringTb4b4b4,

Tff7b72val Te6edf3generatedAtTb4b4b4: Tffa657StringTb4b4b4,

Tff7b72val Te6edf3totalBytesTb4b4b4: Tffa657LongTb4b4b4,

Tb4b4b4)

T8b949e/** Build-time keyword index entry decoded at runtime. */

Tf0883e@Serializable

Tff7b72data Tff7b72class T56d364KeywordIndexEntryTb4b4b4(

Tff7b72val Te6edf3idTb4b4b4: Tffa657StringTb4b4b4,

Tff7b72val Te6edf3titleTb4b4b4: Tffa657StringTb4b4b4,

Tff7b72val Te6edf3sectionTb4b4b4: Tffa657StringTb4b4b4,

Tff7b72val Te6edf3resourcePathTb4b4b4: Tffa657StringTb4b4b4,

Tff7b72val Te6edf3navOrderTb4b4b4: Tffa657IntTb4b4b4,

Tff7b72val Te6edf3keywordsTb4b4b4: Te6edf3ListTff7b72<Tffa657StringTff7b72>Tb4b4b4,

Tff7b72val Te6edf3aliasesTb4b4b4: Te6edf3ListTff7b72<Tffa657StringTff7b72> Tff7b72= Te6edf3emptyListTb4b4b4(Tb4b4b4)Tb4b4b4,

Tff7b72val Te6edf3charCountTb4b4b4: Tffa657IntTb4b4b4,

Tff7b72val Te6edf3iconIdTb4b4b4: Tffa657String? Tff7b72= Tff7b72nullTb4b4b4,

Tb4b4b4)

T8b949e/** Normalized user search query. */

Tff7b72data Tff7b72class T56d364DocSearchQueryTb4b4b4(Tff7b72val Te6edf3rawTextTb4b4b4: Tffa657StringTb4b4b4, Tff7b72val Te6edf3normalizedTermsTb4b4b4: Te6edf3ListTff7b72<Tffa657StringTff7b72>Tb4b4b4)

T8b949e/** Ranked search result. */

Tff7b72data Tff7b72class T56d364DocSearchResultTb4b4b4(Tff7b72val Te6edf3pageTb4b4b4: Te6edf3DocPageTb4b4b4, Tff7b72val Te6edf3scoreTb4b4b4: Tffa657IntTb4b4b4, Tff7b72val Te6edf3matchedTermsTb4b4b4: Te6edf3ListTff7b72<Tffa657StringTff7b72>Tb4b4b4)

T8b949e/** AI assistant result model. */

Tff7b72sealed Tff7b72interface T56d364AIDocAssistantResult Tb4b4b4{

Tff7b72data Tff7b72class T56d364PartialTb4b4b4(Tff7b72val Te6edf3answerTb4b4b4: Tffa657StringTb4b4b4, Tff7b72val Te6edf3sourcePagesTb4b4b4: Te6edf3ListTff7b72<Te6edf3DocPageTff7b72>Tb4b4b4, Tff7b72val Te6edf3usedOnDeviceModelTb4b4b4: Tffa657BooleanTb4b4b4) Tb4b4b4:

Te6edf3AIDocAssistantResult

Tff7b72data Tff7b72class T56d364SuccessTb4b4b4(Tff7b72val Te6edf3answerTb4b4b4: Tffa657StringTb4b4b4, Tff7b72val Te6edf3sourcePagesTb4b4b4: Te6edf3ListTff7b72<Te6edf3DocPageTff7b72>Tb4b4b4, Tff7b72val Te6edf3usedOnDeviceModelTb4b4b4: Tffa657BooleanTb4b4b4) Tb4b4b4:

Te6edf3AIDocAssistantResult

Tff7b72data Tff7b72class T56d364FallbackTb4b4b4(Tff7b72val Te6edf3messageTb4b4b4: Tffa657StringTb4b4b4, Tff7b72val Te6edf3suggestedPagesTb4b4b4: Te6edf3ListTff7b72<Te6edf3DocPageTff7b72>Tb4b4b4) Tb4b4b4: Te6edf3AIDocAssistantResult

Tff7b72data Tff7b72class T56d364ErrorTb4b4b4(Tff7b72val Te6edf3reasonTb4b4b4: Te6edf3DocsAiErrorTb4b4b4, Tff7b72val Te6edf3suggestedPagesTb4b4b4: Te6edf3ListTff7b72<Te6edf3DocPageTff7b72> Tff7b72= Te6edf3emptyListTb4b4b4(Tb4b4b4)Tb4b4b4) Tb4b4b4: Te6edf3AIDocAssistantResult

Tb4b4b4}

T8b949e/** AI error categories. */

Tff7b72sealed Tff7b72interface T56d364DocsAiError Tb4b4b4{

Tff7b72data Tff7b72object T56d364UnsupportedPlatform Tb4b4b4: Te6edf3DocsAiError

Tff7b72data Tff7b72object T56d364UnsupportedFlavor Tb4b4b4: Te6edf3DocsAiError

Tff7b72data Tff7b72object T56d364ModelUnavailable Tb4b4b4: Te6edf3DocsAiError

Tff7b72data Tff7b72object T56d364Busy Tb4b4b4: Te6edf3DocsAiError

Tff7b72data Tff7b72object T56d364TokenBudgetExceeded Tb4b4b4: Te6edf3DocsAiError

Tff7b72data Tff7b72object T56d364Unknown Tb4b4b4: Te6edf3DocsAiError

Tb4b4b4}

T8b949e/** Model readiness state for download/lifecycle UX. */

Tff7b72sealed Tff7b72interface T56d364ModelReadiness Tb4b4b4{

T8b949e/** Initial status check in progress. */

Tff7b72data Tff7b72object T56d364Checking Tb4b4b4: Te6edf3ModelReadiness

T8b949e/** Model is downloading. [totalBytes] of 0 means indeterminate progress. */

Tff7b72data Tff7b72class T56d364DownloadingTb4b4b4(Tff7b72val Te6edf3bytesDownloadedTb4b4b4: Tffa657LongTb4b4b4, Tff7b72val Te6edf3totalBytesTb4b4b4: Tffa657LongTb4b4b4) Tb4b4b4: Te6edf3ModelReadiness Tb4b4b4{

T8b949e/** Download progress as a fraction (0.0 to 1.0), or null if indeterminate. */

Tff7b72val Te6edf3progressTb4b4b4: Tffa657Float?

Tff7b72getTb4b4b4(Tb4b4b4) Tff7b72= Tff7b72if Tb4b4b4(Te6edf3totalBytes Tff7b72> T79c0ff0Tb4b4b4) Tb4b4b4(Te6edf3bytesDownloadedTb4b4b4.Te6edf3toFloatTb4b4b4(Tb4b4b4) Tff7b72/ Te6edf3totalBytesTb4b4b4)Tb4b4b4.Te6edf3coerceInTb4b4b4(T79c0ff0fTb4b4b4, T79c0ff1fTb4b4b4) Tff7b72else Tff7b72null

Tb4b4b4}

T8b949e/** Model is ready for inference. */

Tff7b72data Tff7b72object T56d364Available Tb4b4b4: Te6edf3ModelReadiness

T8b949e/** Model is not available on this device. */

Tff7b72data Tff7b72class T56d364UnavailableTb4b4b4(Tff7b72val Te6edf3reasonTb4b4b4: Tffa657String?Tb4b4b4) Tb4b4b4: Te6edf3ModelReadiness

Tb4b4b4}

T8b949e/** Chirpy assistant session state. */

Tff7b72data Tff7b72class T56d364AIDocAssistantSessionStateTb4b4b4(

Tff7b72val Te6edf3messagesTb4b4b4: Te6edf3ListTff7b72<Te6edf3ChirpyMessageTff7b72> Tff7b72= Te6edf3emptyListTb4b4b4(Tb4b4b4)Tb4b4b4,

Tff7b72val Te6edf3isLoadingTb4b4b4: Tffa657Boolean Tff7b72= Tff7b72falseTb4b4b4,

Tff7b72val Te6edf3draftQuestionTb4b4b4: Tffa657String Tff7b72= Ta5d6ff"Ta5d6ff"Tb4b4b4,

Tb4b4b4)

T8b949e/** Reference to a source doc page shown as a chip in Chirpy replies. */

Tf0883e@Serializable Tff7b72data Tff7b72class T56d364SourceRefTb4b4b4(Tff7b72val Te6edf3idTb4b4b4: Tffa657StringTb4b4b4, Tff7b72val Te6edf3titleTb4b4b4: Tffa657StringTb4b4b4)

T8b949e/** A single message in the Chirpy conversation. */

Tf0883e@Serializable

Tff7b72data Tff7b72class T56d364ChirpyMessageTb4b4b4(

Tff7b72val Te6edf3idTb4b4b4: Tffa657StringTb4b4b4,

Tff7b72val Te6edf3roleTb4b4b4: Te6edf3ChirpyRoleTb4b4b4,

Tff7b72val Te6edf3textTb4b4b4: Tffa657StringTb4b4b4,

Tff7b72val Te6edf3sourcesTb4b4b4: Te6edf3ListTff7b72<Te6edf3SourceRefTff7b72> Tff7b72= Te6edf3emptyListTb4b4b4(Tb4b4b4)Tb4b4b4,

Tb4b4b4)

T8b949e/** Message author role. */

Tf0883e@Serializable

Tff7b72enum Tff7b72class T56d364ChirpyRole Tb4b4b4{

Te6edf3USERTb4b4b4,

Te6edf3ASSISTANTTb4b4b4,

Te6edf3SYSTEMTb4b4b4,

Tb4b4b4}

T8b949e/** Indicates the source of displayed page content for translation attribution. */

Tff7b72enum Tff7b72class T56d364TranslationSource Tb4b4b4{

T8b949e/** English source or Crowdin community translation. */

Te6edf3BUNDLEDTb4b4b4,

T8b949e/** ML Kit on-device auto-translation (Google flavor only). */

Te6edf3ML_KITTb4b4b4,

Tb4b4b4}